<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/detail/session_shared_name.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li><li class="navelem"><a class="el" href="dir_b920fd4362476866a1b4325a80ed2bf5.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">session_shared_name.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="session__shared__name_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="session__fwd_8hpp.html">ipc/session/session_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="shared__name_8hpp.html">ipc/util/shared_name.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session.html">ipc::session</a></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">/* Normally we&#39;d put these prototypes into detail/session_fwd.hpp nearby; but there are some minor subtleties</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * preventing this.  For one there&#39;s a reference to Shared_name::S_SENTINEL as a defaul arg, which means</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * #include &quot;ipc/util/shared_name.hpp&quot; would be needed -- not cool in a _fwd.hpp.  Secondly there&#39;s the</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * many references to Shared_name -- which session_fwd.hpp aliases to util::Shared_name -- but session_fwd.hpp</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * needs detail/session_fwd.hpp for other reasons; so this creates a circular issue.  Because of these,</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * it&#39;s not in detail/session_fwd.hpp; nor in some kind of seaparate session_shared_name_fwd.hpp either.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> *</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * It&#39;s not really a huge deal, but it *is* a break from the recommended _fwd.hpp convention; seemed worth</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * explaining. */</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">/**</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * Builds an absolute name according to the path convention explained in Shared_name class doc header;</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * this overload applies to non-global-scope resources within the ipc::session paradigm.  Typically one</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * would then add a util::Shared_name::S_SEPARATOR and then purpose-specific path component(s) (via `/=` or</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * similar).</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * Behavior is undefined if a path fragment argument is empty (assertion may trip).</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * @param resource_type</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *        Resource type constant.  Typically it is available as a `S_RESOURCE_TYPE_ID` constant in some class;</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *        otherwise as a `Shared_name::S_RESOURCE_TYPE_ID_*` constant.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * @param srv_app_name</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *        Session-server application name; typically from Server_app::m_name.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * @param srv_namespace</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *        The server namespace, uniquely identifying the server application *instance* (process) across all time,</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *        for the given `srv_app_name`.  (I.e., it need only be unique given the particular `resource_type` and</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *        `srv_app_name`.)</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * @param cli_app_name</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *        Session-client application name; typically from Client_app::m_name.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * @param cli_namespace_or_sentinel</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *        The client namespace, uniquely identifying the client application *instance* (process), for the given</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *        set of values in preceding args.  (I.e., it need only be unique given the particular values combo in</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> *        the preceding args.)  If the name applies to all instances of `cli_app_name` this shall be</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *        util::Shared_name::S_SENTINEL.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * @return Absolute path not ending in `S_SEPARATOR`, typically to be appended with a `S_SEPARATOR` and more</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *         component(s) by the caller.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> */</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1session.html#a365d2d63f77b738e67e206af6b702634">build_conventional_shared_name</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; resource_type, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; srv_app_name,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>                                           <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; srv_namespace, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; cli_app_name,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>                                           <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; cli_namespace_or_sentinel</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>                                             = <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">Shared_name::S_SENTINEL</a>);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"></span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">/**</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * Builds an absolute name according to the path convention explained in Shared_name class doc header;</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * this overload applies to global-scope resources within the ipc::session paradigm.  Typically one</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * would then add a util::Shared_name::S_SEPARATOR and then purpose-specific path component(s)</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * (via `/=` or similar).  Note that this overload supports both of the following situations:</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *   - Applicable to a particular Server_app *instance* (process).</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> *   - Applicable to *all* such instances (processes).  Then set `srv_namespace_or_sentinel = S_SENTINEL`.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> *</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * Arguably the former is more common.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * Behavior is undefined if a path fragment argument is empty (assertion may trip).</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * @param resource_type</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> *        Resource type constant.  Typically it is available as a `S_RESOURCE_TYPE_ID` constant in some class;</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> *        otherwise as a `Shared_name::S_RESOURCE_TYPE_ID_*` constant.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * @param srv_app_name</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> *        Session-server application name; typically from Server_app::m_name.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * @param srv_namespace_or_sentinel</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *        The server namespace, uniquely identifying the server application *instance* (process) across all time,</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *        for the given `srv_app_name`.  (I.e., it need only be unique given the particular `resource_type` and</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *        `srv_app_name`.)  Alternatively it may equal `S_SENTINEL`, indicating the resource applies to</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *        *all* instances of `srv_app_name` (unique Server_app).</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * @return Absolute path not ending in `S_SEPARATOR`, typically to be appended with a `S_SEPARATOR` and more</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *         component(s) by the caller.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> */</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1session.html#a365d2d63f77b738e67e206af6b702634">build_conventional_shared_name</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; resource_type, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; srv_app_name,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>                                           <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; srv_namespace_or_sentinel</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>                                             = <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">Shared_name::S_SENTINEL</a>);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"></span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">/**</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * Decomposes a Shared_name built as-if by build_conventional_shared_name() overload 1 (non-global-scope); setting</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * the various component values as out-args; or returning `false` if the name does not follow the</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * conventions of that build_conventional_shared_name() overload.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * Important: In order for this to return `true` (and thus optionally set any out-args), `name` must</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * be as-if it is a concatenation of:</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *   - The build_conventional_shared_name() (overload 1/non-global-scope) result.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *   - `S_SEPARATOR`.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *   - 0 or more characters (which are placed into `*the_rest` if not-null).</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> *</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * I.e., `name` cannot be the result of build_conventional_shared_name() alone but also a separator and possibly</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * more characters.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * @param name</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *        Name to check/decompose.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * @param resource_type</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> *        If not-null, pointee is set to `resource_type` as-if given to build_conventional_shared_name() overload 1</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *        (non-global-scope).  If null ignored.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * @param srv_app_name</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> *        If not-null, pointee is set to `srv_app_name` as-if given to build_conventional_shared_name() overload 1</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *        (non-global-scope).  If null ignored.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * @param srv_namespace</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *        If not-null, pointee is set to `srv_namespace` as-if given to build_conventional_shared_name() overload 1</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> *        (non-global-scope).  If null ignored.  This will never equal `S_SENTINEL`.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * @param cli_app_name</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *        If not-null, pointee is set to `cli_app_name` as-if given to build_conventional_shared_name() overload 1</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *        (non-global-scope).  If null ignored.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * @param cli_namespace_or_sentinel</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *        If not-null, pointee is set to `cli_namespace_or_sentinel` as-if given to build_conventional_shared_name()</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> *        overload 1 (non-global-scope).  If null ignored.  This may equal `S_SENTINEL`.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * @param the_rest</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *        If not-null, pointee is set to whatever follows the above components (even if some or all of their out-args</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *        were null) and the `S_SEPARATOR` immediately following the last of the above components.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> *        To be clear: that `S_SEPARATOR` itself is not included as the leading character of `*the_rest`.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> *        If null ignored.  This may be `.empty()`.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> * @return `true` if and only if the name could be decomposed, meaning it was built as described above.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> */</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceipc_1_1session.html#ac970e7d7b97c1a9737bd836a6a7f77ec">decompose_conventional_shared_name</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; name,</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>                                        <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* resource_type, <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* srv_app_name,</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>                                        <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* srv_namespace, <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* cli_app_name,</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>                                        <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* cli_namespace_or_sentinel, <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* the_rest);</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"></span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">/**</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> * Decomposes a Shared_name built as-if by build_conventional_shared_name() overload 2 (global-scope); setting</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> * the various component values as out-args; or returning `false` if the name does not follow the</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> * conventions of that build_conventional_shared_name() overload.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * Important: In order for this to return `true` (and thus optionally set any out-args), `name` must</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * be as-if it is a concatenation of:</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *   - The build_conventional_shared_name() (overload 2/global-scope) result.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *   - `S_SEPARATOR`.</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> *   - 0 or more characters (which are placed into `*the_rest` if not-null).</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> *</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * I.e., `name` cannot be the result of build_conventional_shared_name() alone but also a separator and possibly</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * more characters.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> *</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * @param name</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> *        Name to check/decompose.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * @param resource_type</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *        If not-null, pointee is set to `resource_type` as-if given to build_conventional_shared_name() overload 2</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> *        (global-scope).  If null ignored.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * @param srv_app_name</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *        If not-null, pointee is set to `srv_app_name` as-if given to build_conventional_shared_name() overload 2</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> *        (global-scope).  If null ignored.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * @param srv_namespace_or_sentinel</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> *        If not-null, pointee is set to `srv_namespace_or_sentinel` as-if given to build_conventional_shared_name()</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *        overload 2 (global-scope).  If null ignored.  This will may equal `S_SENTINEL`.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * @param the_rest</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *        If not-null, pointee is set to whatever follows the above components (even if some or all of their out-args</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *        were null), the `S_SENTINEL`, and the `S_SEPARATOR` immediately following the last of the above components.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *        To be clear: that `S_SEPARATOR` itself is not included as the leading character of `*the_rest`.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *        If null ignored.  This may be `.empty()`.</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * @return `true` if and only if the name could be decomposed, meaning it was built as described above.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *         If `false` none of the out-args are touched.</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> */</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceipc_1_1session.html#ac970e7d7b97c1a9737bd836a6a7f77ec">decompose_conventional_shared_name</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; name,</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>                                        <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* resource_type, <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* srv_app_name,</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>                                        <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* srv_namespace_or_sentinel, <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>* the_rest);</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"></span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">/**</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * Return the prefix common to all calls to either build_conventional_shared_name() overload with</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * the args `resource_type` and `srv_app_name`.  For example one can use a value built by this function as the</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> * util::remove_each_persistent_with_name_prefix() prefix arg.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * Note that the returned value *always* ends with `S_SEPARATOR`.</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> *</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * @param resource_type</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> *        See build_conventional_shared_name() (either overload).</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * @param srv_app_name</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *        See build_conventional_shared_name() (either overload).</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * @return Absolute path prefix ending `S_SEPARATOR`.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> */</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a> <a class="code hl_function" href="namespaceipc_1_1session.html#a5216d618bb573e68276d2933ce3f4010">build_conventional_shared_name_prefix</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; resource_type, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">Shared_name</a>&amp; srv_app_name);</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>} <span class="comment">// namespace ipc::session</span></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a43205a00865429c1bef6c7896816bf5c"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">ipc::util::Shared_name::S_SENTINEL</a></div><div class="ttdeci">static const Shared_name S_SENTINEL</div><div class="ttdoc">A Shared_name fragment, with no S_SEPARATOR characters inside, that represents a path component that ...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00280">shared_name.hpp:280</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html"><div class="ttname"><a href="namespaceipc_1_1session.html">ipc::session</a></div><div class="ttdoc">Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00026">app.cpp:27</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a365d2d63f77b738e67e206af6b702634"><div class="ttname"><a href="namespaceipc_1_1session.html#a365d2d63f77b738e67e206af6b702634">ipc::session::build_conventional_shared_name</a></div><div class="ttdeci">Shared_name build_conventional_shared_name(const Shared_name &amp;resource_type, const Shared_name &amp;srv_app_name, const Shared_name &amp;srv_namespace, const Shared_name &amp;cli_app_name, const Shared_name &amp;cli_namespace_or_sentinel)</div><div class="ttdoc">Builds an absolute name according to the path convention explained in Shared_name class doc header; t...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2detail_2session__shared__name_8cpp_source.html#l00043">session_shared_name.cpp:44</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a5216d618bb573e68276d2933ce3f4010"><div class="ttname"><a href="namespaceipc_1_1session.html#a5216d618bb573e68276d2933ce3f4010">ipc::session::build_conventional_shared_name_prefix</a></div><div class="ttdeci">Shared_name build_conventional_shared_name_prefix(const Shared_name &amp;resource_type, const Shared_name &amp;srv_app_name)</div><div class="ttdoc">Return the prefix common to all calls to either build_conventional_shared_name() overload with the ar...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2detail_2session__shared__name_8cpp_source.html#l00093">session_shared_name.cpp:93</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a6d07d9996af19e57eb42416e914110ea"><div class="ttname"><a href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">ipc::session::Shared_name</a></div><div class="ttdeci">util::Shared_name Shared_name</div><div class="ttdoc">Convenience alias for the commonly used type util::Shared_name.</div><div class="ttdef"><b>Definition:</b> <a href="session__fwd_8hpp_source.html#l00245">session_fwd.hpp:245</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_ac970e7d7b97c1a9737bd836a6a7f77ec"><div class="ttname"><a href="namespaceipc_1_1session.html#ac970e7d7b97c1a9737bd836a6a7f77ec">ipc::session::decompose_conventional_shared_name</a></div><div class="ttdeci">bool decompose_conventional_shared_name(const Shared_name &amp;name, Shared_name *resource_type, Shared_name *srv_app_name, Shared_name *srv_namespace, Shared_name *cli_app_name, Shared_name *cli_namespace_or_sentinel, Shared_name *the_rest)</div><div class="ttdoc">Decomposes a Shared_name built as-if by build_conventional_shared_name() overload 1 (non-global-scope...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2detail_2session__shared__name_8cpp_source.html#l00114">session_shared_name.cpp:114</a></div></div>
<div class="ttc" id="asession__fwd_8hpp_html"><div class="ttname"><a href="session__fwd_8hpp.html">session_fwd.hpp</a></div></div>
<div class="ttc" id="ashared__name_8hpp_html"><div class="ttname"><a href="shared__name_8hpp.html">shared_name.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
